Fix user password reset mail template value by erikbocks · Pull Request #12882 · apache/cloudstack

erikbocks · 2026-03-24T19:52:06Z

Description

The #11379 and #12078 PRs changed the user password email template, stored in the user.password.reset.mail.template configuration value. However, these changes were only made to the configuration's default value, and the database's configuration value was not changed. This caused environments that were deployed before the 4.22.0.0 release to face errors due to outdated configuration values, such as the duplicated HTTP protocol in the URL.

This PR adds a step in the 4.22.0.0 version to 4.22.1.0 version update script to update the user.password.reset.mail.template configuration value to the current value, if its current value matches one of the old defaults. The step changes the configuration's value only if the current value is one of the outdated default ones, keeping customized templates untouched.

Old default templates

With HTTP:

Hello {{username}}!
You have requested to reset your password. Please click the following link to reset your password:
http://{{{resetLink}}}
If you did not request a password reset,please ignore this email.

Regards,
The CloudStack Team

With domainUrl:

Hello {{username}}!
You have requested to reset your password. Please click the following link to reset your password:
{{{domainUrl}}}{{{resetLink}}}
If you did not request a password reset,please ignore this email.

Regards,
The CloudStack Team

New default template

Hello {{username}}!
You have requested to reset your password. Please click the following link to reset your password:
{{{resetLink}}}
If you did not request a password reset,please ignore this email.

Regards,
The CloudStack Team

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

In an environment where the user.password.reset.mail.template configuration had the http:// value, I manually executed the query to replace the configuration's value, and asserted that the value was changed accordingly. Then, I updated the configuration to the {{{domainUrl}}} outdated template, and manually executed the query one more time. The configuration's value was updated to the current template successfully.

In order to test ACS' automatic update behavior, the query was inserted to the version update SQL file, and the packages with the changes were installed in an environment previous to the 4.22.1.0 version. The correct behavior was observed for both of the outdated templates.

With the environment updated in the previous step, a password reset email was sent, and I validated that the template was working properly.

codecov · 2026-03-24T20:01:42Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 17.60%. Comparing base (7c3637a) to head (6b761c9).
⚠️ Report is 12 commits behind head on 4.22.

Additional details and impacted files

@@             Coverage Diff              @@
##              4.22   #12882       +/-   ##
============================================
+ Coverage     3.70%   17.60%   +13.89%     
- Complexity       0    15674    +15674     
============================================
  Files          448     5918     +5470     
  Lines        38041   531668   +493627     
  Branches      7038    65001    +57963     
============================================
+ Hits          1409    93590    +92181     
- Misses       36445   427522   +391077     
- Partials       187    10556    +10369

Flag	Coverage Δ
uitests	`3.70% <ø> (-0.01%)`	⬇️
unittests	`18.67% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…t-value

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

Co-authored-by: GaOrtiga <49285692+GaOrtiga@users.noreply.github.com>

GaOrtiga

LGTM

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

sureshanaparti · 2026-03-26T13:01:39Z

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

+SET value = 'Hello {{username}}!\nYou have requested to reset your password. Please click the following link to reset your password:\n{{{resetLink}}}\nIf you did not request a password reset,please ignore this email.\n\nRegards,\nThe CloudStack Team'
+WHERE value IN (
+    'Hello {{username}}!\nYou have requested to reset your password. Please click the following link to reset your password:\nhttp://{{{resetLink}}}\nIf you did not request a password reset,please ignore this email.\n\nRegards,\nThe CloudStack Team',
+    'Hello {{username}}!\nYou have requested to reset your password. Please click the following link to reset your password:\n{{{domainUrl}}}{{{resetLink}}}\nIf you did not request a password reset,please ignore this email.\n\nRegards,\nThe CloudStack Team'


agree to update the value if it has the previous defaults. ConfigDepot does not update value.

cloudstack/framework/config/src/main/java/org/apache/cloudstack/framework/config/impl/ConfigDepotImpl.java

Lines 208 to 213 in c1af36f

if (vo.isDynamic() != key.isDynamic() || !ObjectUtils.equals(vo.getDescription(), key.description()) || !ObjectUtils.equals(vo.getDefaultValue(), key.defaultValue()) ||

!ObjectUtils.equals(vo.getScope(), key.getScopeBitmask()) ||

!ObjectUtils.equals(vo.getComponent(), componentName)) {

vo.setDynamic(key.isDynamic());

vo.setDescription(key.description());

vo.setDefaultValue(key.defaultValue());

Co-authored-by: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

sureshanaparti

minor nit, clgtm

Co-authored-by: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>

sureshanaparti · 2026-03-27T07:02:19Z

@blueorangutan package

blueorangutan · 2026-03-27T07:04:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-03-27T07:59:28Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17265

sureshanaparti · 2026-03-27T09:15:25Z

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

+WHERE value IN (
+    'Hello {{username}}!\nYou have requested to reset your password. Please click the following link to reset your password:\nhttp://{{{resetLink}}}\nIf you did not request a password reset,please ignore this email.\n\nRegards,\nThe CloudStack Team',
+    'Hello {{username}}!\nYou have requested to reset your password. Please click the following link to reset your password:\n{{{domainUrl}}}{{{resetLink}}}\nIf you did not request a password reset,please ignore this email.\n\nRegards,\nThe CloudStack Team'
+)


@erikbocks the sql doesn't work, \n is not required in the update stmt. can you try and update the pr with the below stmt. thanks.

UPDATE `cloud`.`configuration` SET value = 'Hello {{username}}! You have requested to reset your password. Please click the following link to reset your password: {{{resetLink}}} If you did not request a password reset, please ignore this email. Regards, The CloudStack Team' WHERE name = 'user.password.reset.mail.template' AND value IN ( 'Hello {{username}}! You have requested to reset your password. Please click the following link to reset your password: http://{{{resetLink}}} If you did not request a password reset, please ignore this email. Regards, The CloudStack Team', 'Hello {{username}}! You have requested to reset your password. Please click the following link to reset your password: {{{domainUrl}}}{{{resetLink}}} If you did not request a password reset, please ignore this email. Regards, The CloudStack Team' );

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

Co-authored-by: GaOrtiga <49285692+GaOrtiga@users.noreply.github.com>

GaOrtiga · 2026-03-27T18:18:16Z

@sureshanaparti Which DB are you using? I tested with MariaDB V15.1 and it worked. I'm thinking it could be an issue with how different DBs handle these line breaks.

sureshanaparti · 2026-04-01T07:13:19Z

@sureshanaparti Which DB are you using? I tested with MariaDB V15.1 and it worked. I'm thinking it could be an issue with how different DBs handle these line breaks.

@erikbocks I tested with MySQL 8.0.45, let me check with latest changes.

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

sureshanaparti · 2026-04-01T07:14:29Z

@blueorangutan package

blueorangutan · 2026-04-01T07:16:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-01T08:18:51Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17320

…10.sql Co-authored-by: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

Co-authored-by: GaOrtiga <49285692+GaOrtiga@users.noreply.github.com>

sureshanaparti · 2026-04-01T18:13:56Z

@blueorangutan package

blueorangutan · 2026-04-01T18:16:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-01T19:18:19Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17331

github-actions · 2026-04-02T04:19:25Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

erikbocks added 3 commits March 24, 2026 15:20

Fix default user password reset email template

7a55eef

improve readabilty

34cb3b6

change update query

29e28c2

erikbocks requested a review from sureshanaparti March 24, 2026 19:57

erikbocks changed the base branch from main to 4.22 March 24, 2026 20:00

Merge remote-tracking branch 'origin/4.22' into fix-reset-link-defaul…

dc929f1

…t-value

GaOrtiga reviewed Mar 26, 2026

View reviewed changes

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql Outdated Show resolved Hide resolved

Apply suggestion from @GaOrtiga

4c6157b

Co-authored-by: GaOrtiga <49285692+GaOrtiga@users.noreply.github.com>

GaOrtiga approved these changes Mar 26, 2026

View reviewed changes

sureshanaparti reviewed Mar 26, 2026

View reviewed changes

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql Outdated Show resolved Hide resolved

sureshanaparti reviewed Mar 26, 2026

View reviewed changes

sureshanaparti added this to the 4.22.1 milestone Mar 26, 2026

sureshanaparti added this to Apache CloudStack 4.22.1 Mar 26, 2026

github-project-automation bot moved this to Todo in Apache CloudStack 4.22.1 Mar 26, 2026

Add newline at the end of file

d9bd43e

Co-authored-by: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>

sureshanaparti reviewed Mar 26, 2026

View reviewed changes

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql Outdated Show resolved Hide resolved

sureshanaparti approved these changes Mar 26, 2026

View reviewed changes

sureshanaparti moved this from Todo to In Progress in Apache CloudStack 4.22.1 Mar 26, 2026

Specify database for update

29cb0b9

Co-authored-by: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>

sureshanaparti reviewed Mar 27, 2026

View reviewed changes

sureshanaparti self-requested a review March 27, 2026 09:29

sureshanaparti requested changes Mar 27, 2026

View reviewed changes

sureshanaparti added the status:needs-work label Mar 27, 2026

GaOrtiga reviewed Mar 27, 2026

View reviewed changes

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql Outdated Show resolved Hide resolved

Address Ortiga's review

c7c48f1

Co-authored-by: GaOrtiga <49285692+GaOrtiga@users.noreply.github.com>

sureshanaparti reviewed Apr 1, 2026

View reviewed changes

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql Show resolved Hide resolved

Update engine/schema/src/main/resources/META-INF/db/schema-42200to422…

68b76a9

…10.sql Co-authored-by: Suresh Kumar Anaparti <sureshkumar.anaparti@gmail.com>

GaOrtiga reviewed Apr 1, 2026

View reviewed changes

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql Outdated Show resolved Hide resolved

Fix SQL statement

6b761c9

Co-authored-by: GaOrtiga <49285692+GaOrtiga@users.noreply.github.com>

github-actions bot added the status:has-conflicts label Apr 2, 2026

	if (vo.isDynamic() != key.isDynamic() \|\| !ObjectUtils.equals(vo.getDescription(), key.description()) \|\| !ObjectUtils.equals(vo.getDefaultValue(), key.defaultValue()) \|\|
	!ObjectUtils.equals(vo.getScope(), key.getScopeBitmask()) \|\|
	!ObjectUtils.equals(vo.getComponent(), componentName)) {
	vo.setDynamic(key.isDynamic());
	vo.setDescription(key.description());
	vo.setDefaultValue(key.defaultValue());

Conversation

erikbocks commented Mar 24, 2026

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

codecov bot commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

GaOrtiga left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sureshanaparti Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Mar 27, 2026

Uh oh!

blueorangutan commented Mar 27, 2026

Uh oh!

blueorangutan commented Mar 27, 2026

Uh oh!

sureshanaparti Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GaOrtiga commented Mar 27, 2026

Uh oh!

sureshanaparti commented Apr 1, 2026

Uh oh!

Uh oh!

sureshanaparti commented Apr 1, 2026

Uh oh!

blueorangutan commented Apr 1, 2026

Uh oh!

blueorangutan commented Apr 1, 2026

Uh oh!

Uh oh!

sureshanaparti commented Apr 1, 2026

Uh oh!

blueorangutan commented Apr 1, 2026

Uh oh!

blueorangutan commented Apr 1, 2026

Uh oh!

github-actions bot commented Apr 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Mar 24, 2026 •

edited

Loading

sureshanaparti Mar 27, 2026 •

edited

Loading